Add annotaterb and run annotations#1516
Merged
Merged
Conversation
Why these changes are being introduced: The annotate gem has been deprecated. We need a new gem to run annotations in Rails 8. Relevant ticket(s): - [ETD-693](https://mitlibraries.atlassian.net/browse/ETD-693) How this addresses that need: This adds the annotaterb gem and annotates models and routes. Side effects of this change: None
|
coverage: 98.25%. remained the same — annotaterb into main |
JPrevost
reviewed
Jul 21, 2026
JPrevost
left a comment
JPrevost
left a comment
Member
There was a problem hiding this comment.
Would you consider adding a note to the readme like this one to keep the annotations just models? I'm not sure if the route decorations this added are helpful. I'm open to normalizing the other way though if you feel strongly it is helpful.
https://github.com/MITLibraries/timdex/blob/main/README.md#developing-this-application
JPrevost
reviewed
Jul 21, 2026
|
|
||
| ### Annotations | ||
|
|
||
| Please `bundle exec annotaterb models` when making changes to models to update the internal documentation. |
Member
There was a problem hiding this comment.
This is great but there is another note about this that is now contradictory in this readme. Once you reconcile this is good to go.
JPrevost
approved these changes
Jul 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why these changes are being introduced:
The annotate gem has been deprecated. We need a
new gem to run annotations in Rails 8.
Relevant ticket(s):
How this addresses that need:
This adds the annotaterb gem and annotates models
and routes.
Side effects of this change:
None
Developer
our guide and
all issues introduced by these changes have been resolved or opened as new
issues (link to those issues in the Pull Request details above)
Code Reviewer
(not just this pull request message)
Requires database migrations?
NO
Includes new or updated dependencies?
YES